Optimize the help context when command has a sub

您所在的位置:网站首页 kubectl create configmap Optimize the help context when command has a sub

Optimize the help context when command has a sub

#Optimize the help context when command has a sub| 来源: 网络整理| 查看: 265

The helping context of a command which has a sub-command is a little ambiguous. For example when creating secret it says:

$ kubectl create secret -h Create a secret using specified subcommand. Available Commands: docker-registry Create a secret for use with a Docker registry generic Create a secret from a local file, directory, or literal value tls Create a TLS secret Usage: kubectl create secret [flags] [options] Use "kubectl --help" for more information about a given command. Use "kubectl options" for a list of global command-line options (applies to all commands).

in Usage part

Usage: kubectl create secret [flags] [options]

In fact it's not '[flags]' but '[subcommands]' or just '[commands]' Also

Use "kubectl --help" for more information about a given command. Use "kubectl options" for a list of global command-line options (applies to all commands).

is an ambiguous expression(I think), it would be better if it shows

Use "kubectl create secret --help" for more information about a given command. Use "kubectl options" for a list of global command-line options (applies to all commands).

or remove these two sentences e.g. configmap or other resources. After a short research I do realize that these two sentences are general expressions of commands which have sub-commands, but it still could be more clear with the specific commands.

What would you like to be added:

$ kubectl create secret -h Create a secret using specified subcommand. Available Commands: docker-registry Create a secret for use with a Docker registry generic Create a secret from a local file, directory, or literal value tls Create a TLS secret Usage: kubectl create secret [commands] [options] Use "kubectl create secret --help" for more information about a given command. Use "kubectl options" for a list of global command-line options (applies to all commands). $ kubectl create -h ... Usage: ... Use "kubectl create --help" for more information about a given command. Use "kubectl options" for a list of global command-line options (applies to all commands).

Clearer expression and guidance. Why is this needed: --help options are usually for learners and beginners, which should be more concise clearer, and helpful.

If you think it should be optimized, please let me know and let me work on it, I've already done some research.



【本文地址】


今日新闻


推荐新闻


CopyRight 2018-2019 办公设备维修网 版权所有 豫ICP备15022753号-3